/*-----------------------------------------------------------------------------
The contents of this file are subject to the Mozilla Public License
Version 1.1 (the "License"); you may not use this file except in
compliance with the License.You may obtain a copy of the License at
http://www.mozilla.org/MPL/MPL-1.1.html
	
Software distributed under the License is distributed on an "AS IS"
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
License for the specific language governing rights and limitations
under the License.
	
The Original Code is Fever RS ( ActionScript 3 ) Framework code.
	
The Initial Developer of the Original Code is Romain Ecarnot.
Portions created by Initial Developer are Copyright (C) 2006
the Initial Developer. All Rights Reserved.
	
Contributor(s):
	
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-----------------------------------------------------------------------------*/

package fever.plugin.manager.events 
{
	import com.bourre.events.BasicEvent;
	import com.bourre.events.EventChannel;	

	/**
	 * @author Romain Ecarnot
	 */
	public class PluginActivationEvent extends BasicEvent
	{
		//--------------------------------------------------------------------
		// Events
		//--------------------------------------------------------------------
		
		/**
		 * Defines the value of the <code>type</code> property of the event 
		 * object for a <code>onPluginActivation</code> event.
		 * 
		 * <p>The properties of the event object have the following values:</p>
	     *  <table class="innertable">
	     *     <tr><th>Property</th><th>Value</th></tr>
	     *     <tr>
	     *     	<td><code>target</code></td>
	     *     	<td>The Object that defines the event listener that handles the event</td>
	     *     </tr>
	     *     <tr>
	     *     	<td><code>type</code></td>
	     *     	<td>Dispatched event type</td>
	     *     </tr>
	     *     <tr>
	     *     	<td><code>activation</code></td>
	     *     	<td><code>true</code> if plugin will be activated, <code>false</code> to desactive it</td>
	     *     </tr>
	     *     <tr>
	     *     	<td><code>channel</code></td>
	     *     	<td>Targeted plugin channel</td>
	     *     </tr>
	     *     
	     *     <tr><th>Method</th><th>Value</th></tr>
	     *     <tr>
	     *     	<td><code>getTarget()</code>
	     *     	</td><td>The Object that defines the
	     *       event listener that handles the event</td></tr>
	     *     <tr>
	     *     	<td><code>getType()</code></td>
	     *     	<td>Dispatched event type</td>
	     *     </tr>
	     *  </table>
	     * 
		 * @eventType onPluginActivation
		 */
		public static const onPluginActivationEVENT : String = "onPluginActivation";
		
		
		//--------------------------------------------------------------------
		// Private properties
		//--------------------------------------------------------------------
		
		private var _bToActivate : Boolean;		private var _channel : EventChannel;

		
		//--------------------------------------------------------------------
		// Public properties
		//--------------------------------------------------------------------
				
		/**
		 * <code>true</code> if plugin is correctly registred in manager.
		 */
		public function get activation() : Boolean { return _bToActivate; }
		
		/**
		 * Plugin channel to activate / desactive.
		 */		public function get channel() : EventChannel { return _channel; }
		
		
		//--------------------------------------------------------------------
		// Public API
		//--------------------------------------------------------------------
		
		/**
		 * Constructor.
		 * 
		 * @param pType Event type
		 * @param pSuccess <code>true</code> if plugin is well registred.
		 */
		public function PluginActivationEvent( pType : String, 
			toActivate : Boolean, pluginChannel : EventChannel )
		{
			super( pType );
			
			_bToActivate = toActivate;			_channel = pluginChannel;		}
	}
}
